-
Notifications
You must be signed in to change notification settings - Fork 195
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(storybook): documentation migration #3125
Conversation
|
🚀 Deployed on https://pr-3125--spectrum-css.netlify.app |
File metricsSummaryTotal size: 4.26 MB* Table reports on changes to a package's main file. Other changes can be found in the collapsed Details section below.
Detailssite
* Results are not gzipped or minified. * An ASCII character in UTF-8 is 8 bits or 1 byte. |
af4fc4c
to
af64ca9
Compare
af64ca9
to
3c6c77a
Compare
224392f
to
4e76087
Compare
9879d72
to
39ff53a
Compare
39ff53a
to
e188c69
Compare
e188c69
to
7a92752
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great! Storybook appears to be working fine locally and in running the production build. I left a couple of questions/thoughts and am also noting that yarn dev
locally is giving me an error message, do we still need it for anything or can it be safely removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Nothing concerning jumps out at me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, I'm so excited for this! ✨✨✨
I have a few questions for you.
- I believe we still have a
buttongroup.yml
file- do we still need that for any particular reason or should it be deleted? - I think we all started a thread in Slack, but I'm curious as to why the production build of Storybook won't have the stories any more. I very well may have missed the discussion and that was the plan all along (I guess I assumed that we were just adding all of our documentation from the docs site to the Storybook). It just caught me off guard that there weren't going to be stories and controls.
7a92752
to
32847e6
Compare
32847e6
to
e3c6ad6
Compare
e3c6ad6
to
1c94841
Compare
1c94841
to
2cec710
Compare
2cec710
to
288394f
Compare
288394f
to
79de389
Compare
3a46b2a
to
189c57d
Compare
@marissahuysentruyt Good catch with the buttongroup.yml file. I got that removed and after our team discussion, removed the "docs-only" flag for the build. |
189c57d
to
a4cb389
Compare
a4cb389
to
556ec56
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So exciting! Thanks for tackling all of this work!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything looks good! I only have two questions before approval:
- Does the
site/package.json
file also need to be removed, now that everything else in there is deleted? - I looked around for any leftover references to the preview URL and saw that there are several references to
dist/preview
in the.storybook/project.json
; do any of those need adjustment or are they fine as-is?
556ec56
to
f15127f
Compare
Good catch! Probably was resurrected during a rebase with main.
Thank you! I've updated these to point to dist now. |
f15127f
to
3df5e15
Compare
Description
Migrate docs site building to leverage Storybook. This PR:
How and where has this been tested?
Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.
Validation steps
yarn build:docs
locally. Open the/dist/index.html
file in the local dev server provided by VSCode. Expect to see a production build of the Storybook sitewith only docs pages.Regression testing
Validate:
To-do list